<RemoteAuthenticationDelegate> Protocol Reference

#include <RemoteAuthenticationDelegate.h>

Inherits <NSObject>.

Public Types
enum	RemoteAuthenticationSessionReason { RemoteAuthenticationSessionExpired , RemoteAuthenticationSessionAccepted , RemoteAuthenticationSessionRefused , RemoteAuthenticationSessionUnknown }

Instance Methods
(void)	- onRemoteAuthenticationForOrchestrationUser:dataToDisplay:caller:
(void)	- onRemoteAuthenticationStepCompleteWithCommand:
(void)	- onRemoteAuthenticationSuccessWithResult:
(void)	- onRemoteAuthenticationSessionOutdated:
(void)	- onRemoteAuthenticationAbortedWithCommand:
(void)	- onRemoteAuthenticationPasswordError:

Detailed Description

The RemoteAuthenticationDelegate interface defines the specific elements required for the integrator to interact during the Remote Authentication flow.

This flow is initiated by the server; it is started by a call to OrchestrationProtocol#execute:(NSString *) with the command provided by the server.

A RemoteAuthenticationDelegate object should be provided to the OrchestrationProtocol object (See OrchestrationProtocol#setRemoteAuthenticationDelegate:(id<RemoteAuthenticationDelegate>)) in order to receive feedback during the remote authentication process.

Member Enumeration Documentation

RemoteAuthenticationSessionReason

- (enum) RemoteAuthenticationSessionReason

The RemoteAuthenticationSessionOutdatedReason lists possible reasons for a session to be outdated.

Enumerator
RemoteAuthenticationSessionExpired
RemoteAuthenticationSessionAccepted
RemoteAuthenticationSessionRefused
RemoteAuthenticationSessionUnknown

Method Documentation

onRemoteAuthenticationAbortedWithCommand:

- (void) onRemoteAuthenticationAbortedWithCommand:

(NSString *_Nullable)

command

Called upon remote authentication abortion

Parameters

command

Optional command that can be sent to the server to notify about the failure

onRemoteAuthenticationForOrchestrationUser:dataToDisplay:caller:

- (void) onRemoteAuthenticationForOrchestrationUser:		(OrchestrationUser *)	user
dataToDisplay:		(NSString *)	dataToDisplay
caller:		(id< RemoteAuthenticationDisplayDataCallerDelegate >)	caller

Called when the Orchestration SDK needs the RemoteAuthenticationDelegate object to display data to the user for approval.

Parameters

dataToDisplay	the data to display
caller	a RemoteAuthenticationDisplayDataCallerDelegate object to use upon user's response
user	the user currently being authenticated

onRemoteAuthenticationPasswordError:

- (void) onRemoteAuthenticationPasswordError:

(PasswordError *)

error

Called when an error occurred during the remote authentication process

Parameters

error

password error

onRemoteAuthenticationSessionOutdated:

- (void) onRemoteAuthenticationSessionOutdated:

(RemoteAuthenticationSessionReason)

reason

Called upon remote authentication session outdated

Parameters

reason

the reason for the session to be outdated

onRemoteAuthenticationStepCompleteWithCommand:

- (void) onRemoteAuthenticationStepCompleteWithCommand:

(NSString *)

command

Called when a step of the remote authentication process is complete. The provided orchestration command is to be sent to the server.

Parameters

command

an orchestration command that must be sent to the server

onRemoteAuthenticationSuccessWithResult:

- (void) onRemoteAuthenticationSuccessWithResult:

(RemoteAuthenticationResult *)

result

Called upon remote authentication success

Parameters

result

the result of the remote authentication, containing the session state and an optional authentication token

---

The documentation for this protocol was generated from the following file:

• RemoteAuthenticationDelegate.h